
<!-- 
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE- 2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License. 
-->

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML>
  <HEAD>
    <LINK type="text/css" rel="stylesheet" href="resources/space.css">
    <STYLE type="text/css">
      .footer {
        background-image:      url('http://cwiki.apache.org/confluence/images/border/border_bottom.gif');
        background-repeat:     repeat-x;
        background-position:   left top;
        padding-top:           4px;
        color:                 #666;
      }
    </STYLE>
    <SCRIPT type="text/javascript" language="javascript">
      var hide = null;
      var show = null;
      var children = null;

      function init() {
        /* Search form initialization */
        var form = document.forms['search'];
        if (form != null) {
          form.elements['domains'].value = location.hostname;
          form.elements['sitesearch'].value = location.hostname;
        }

        /* Children initialization */
        hide = document.getElementById('hide');
        show = document.getElementById('show');
        children = document.all != null ?
                   document.all['children'] :
                   document.getElementById('children');
        if (children != null) {
          children.style.display = 'none';
          show.style.display = 'inline';
          hide.style.display = 'none';
        }
      }

      function showChildren() {
        children.style.display = 'block';
        show.style.display = 'none';
        hide.style.display = 'inline';
      }

      function hideChildren() {
        children.style.display = 'none';
        show.style.display = 'inline';
        hide.style.display = 'none';
      }
    </SCRIPT>
    <TITLE>FtpServer Installation</TITLE>
  <META http-equiv="Content-Type" content="text/html;charset=UTF-8"></HEAD>
  <BODY onload="init()">
    <TABLE border="0" cellpadding="2" cellspacing="0" width="100%">
      <TR class="topBar">
        <TD align="left" valign="middle" class="topBarDiv" nowrap="">
          &nbsp;<A href="index.html" title="Apache MINA FtpServer">Apache MINA FtpServer</A>&nbsp;&gt;&nbsp;<A href="index.html" title="Index">Index</A>&nbsp;&gt;&nbsp;<A href="documentation.html" title="Documentation">Documentation</A>&nbsp;&gt;&nbsp;<A href="" title="FtpServer Installation">FtpServer Installation</A>
        </TD>
      </TR> 
    </TABLE>

    <DIV id="PageContent">
      <DIV class="pageheader" style="padding: 6px 0px 0px 0px;">
        <!-- We'll enable this once we figure out how to access (and save) the logo resource -->
        <!--img src="/wiki/images/confluence_logo.gif" style="float: left; margin: 4px 4px 4px 10px;" border="0"-->
        <DIV style="margin: 0px 10px 0px 10px" class="smalltext">Apache MINA FtpServer</DIV>
        <DIV style="margin: 0px 10px 8px 10px" class="pagetitle">FtpServer Installation</DIV>

        <DIV class="greynavbar" align="right" style="padding: 2px 10px; margin: 0px;">

        </DIV>
      </DIV>

      <DIV class="pagecontent">
        <DIV class="wiki-content">
          <H3><A name="FtpServerInstallation-BinaryDistribution"></A>Binary Distribution</H3>

<P>Download the binary distribution and unzip it. You can run the server in two modes - with and without Java Swing UI. The zip file includes sample configuration files (properties and xml).</P>
<UL>
	<LI>Properties configuration file : &lt;INSTALL_DIR&gt;/res/conf/ftpd.properties</LI>
	<LI>XML configuration file : &lt;INSTALL_DIR&gt;/res/conf/ftpd.xml</LI>
</UL>


<P>If you want to use your own jar files, you can put those jar files in system CLASSPATH or copy those jar files in the &lt;INSTALL_DIR&gt;/common/lib directory.                          If you want to run it using Swing UI, go to &lt;INSTALL_DIR&gt; directory and execute the script ftpd_ui.bat (if Windows) or ftpd_ui.sh (if UNIX).</P>

<P><SPAN class="error">Unable to render embedded object: File (ftp_run.jpg) not found.</SPAN></P>

<P>Similarly, if you want to start the FTP server without Swing UI, go to &lt;INSTALL_DIR&gt; directory and execute ftpd.bat (if Windows) or ftpd.sh (if UNIX or Linux). In this case you need to pass the configuration file location. Usage: </P>
<DIV class="preformatted"><DIV class="preformattedContent">
<PRE>ftpd [&lt;options&gt;]
  &lt;options&gt; := -default |
               -xml &lt;XML configuration file&gt; |
               -prop &lt;properties configuration file&gt;
</PRE>
</DIV></DIV>

<P><SPAN class="nobr"><A href="http://cwiki.apache.org/confluence/pages/createpage.action?spaceKey=FTPSERVER&title=Installing%20FtpServer%20as%20a%20Windows%20service&linkCreation=true&fromPageId=82730" title="Create Page: Installing FtpServer as a Windows service" class="createlink">Installing FtpServer as a Windows service<SUP><IMG class="rendericon" src="http://cwiki.apache.org/confluence/images/icons/plus.gif" height="7" width="7" align="absmiddle" alt="" border="0"></SUP></A></SPAN></P>

<P>There are three ways to start the FTP server.</P>
<UL>
	<LI>-default :: default configuration will be used.</LI>
	<LI>-xml     :: XML configuration will be used. User has to specify the file.</LI>
	<LI>-prop    :: properties configuration will be used. User has to specify the file.</LI>
</UL>


<P>In case of no option, default configuration will be used.</P>

<H4><A name="FtpServerInstallation-BinaryDistributionDirectoryStructure"></A>Binary Distribution Directory Structure</H4>
<DIV class="preformatted"><DIV class="preformattedContent">
<PRE> &lt;INSTALL_DIR&gt;
      |
      |--- common
      |     |
      |     |--- classes
      |     |
      |     |--- lib
      |
      |--- doc
      |     |
      |     |--- javadoc
      |
      |--- res
            |
            |--- conf
            |
            |--- home
            |
            |--- log
</PRE>
</DIV></DIV>
        </DIV>

      </DIV>
    </DIV>
    <DIV class="footer">
    </DIV>
  </BODY>
</HTML>